Update Destination

Route

/v2/streaming/destinations/{destination_id}

Description

Update an existing streaming destination configuration. Only provided fields will be updated, others remain unchanged.

Method

PATCH

Inputs

Parameter	Type	Required	Description
destination_id	string	Yes	Unique identifier of the destination to update
name	string	No	Updated destination name (max 100 characters)
description	string	No	Updated destination description (max 500 characters)
format	string	No	Updated data format (json, json_lines)
encoding	string	No	Updated encoding type (none, gzip)
https_config	object	No	Updated HTTPS configuration object

HTTPS Config Object

Field	Type	Required	Description
uri	string	No	Updated HTTPS endpoint URL
headers	object	No	Updated custom HTTP headers
timeout_seconds	integer	No	Updated request timeout (1-300 seconds)

Request Example

{
  "name": "Updated SIEM Integration",
  "description": "Updated stream to Splunk SIEM",
  "encoding": "none",
  "https_config": {
    "timeout_seconds": 120
  }
}

Output

Field	Type	Description
id	string	Unique destination identifier
name	string	Updated destination name
description	string	Updated destination description
type	string	Destination type
format	string	Updated data format
encoding	string	Updated encoding type
https_config	object	Updated HTTPS configuration details
created_at	string	Creation timestamp (ISO 8601)
updated_at	string	Last update timestamp (ISO 8601)

Rate Limit

• 60 requests per minute per API key
• 5 concurrent requests per endpoint

Example Response

{
  "id": "dest-456",
  "name": "Updated SIEM Integration",
  "description": "Updated stream to Splunk SIEM",
  "type": "https",
  "format": "json_lines",
  "encoding": "none",
  "https_config": {
    "uri": "https://splunk.company.com/services/collector/event",
    "timeout_seconds": 120
  },
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T11:45:00Z"
}